Get a User by UPN (OpenID)

Get a user using the OpenID Principal Name (UPN)

Method

/API2/access/getUserByOpenIdPrincipalName

  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2020.20
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin

Method Signature

Input Parameters

Name

PrincipalName

Type

string

Description

The user's principal name (UPN)

Output Response

Successful Result Code

200

Response Type

PyramidViewUserObject

Description of Response Type

The user object contains all relevant meta-data for the user.

Notes

Use this function to find users in the system using the OpenID user principal name or 'UPN', rather than the user's name or other details.